GET Channels Paged List

Overview

---

The table below provides key details about the GET method for retrieving a paged list of channels.

GET Channels Paged List
Method	GET
URL or Endpoint	/api/v1/projectId/channels
Headers	Authorization
Parameters	projectId, healthStatusId(query), liveStatusId(query), search(query), order(query), insertedDate(query), page(query), take(query)
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
healthStatusId	No	integer($int32)	Health status unique id for the channel
liveStatusId	No	integer($int32)	Live status unique id for the channel
search	No	string	Search for a specific channel
order	No	string	Specified the order position of the channel
insertedDate	No	string($date-time)	Date time
page	No	integer($int32)	Current page you want to receive
take	No	integer($int32)	Number of channels you want to receive
projectId	Yes	string	The id of the project.

Before executing this API, please visit the other API for more information on the properties to achieve the desired response.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": {
    "currentPage": 0,
    "totalPages": 0,
    "pageSize": 0,
    "totalCount": 0,
    "items": [
      {
        "publicId": "string",
        "title": "string",
        "logo": "string",
        "healthStatus": "string",
        "liveStatus": "string",
        "inputType": "string",
        "orderNumber": 0
      }
    ]
  },
  "resultInfo": "string",
  "statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
currentPage	integer($int32)	Returns the current page number in the paginated list of channels.
totalPages	integer($int32)	Returns the total number of pages available for the channel list
pageSize	integer($int32)	Specifies the maximum number of channels that can be displayed on a single page
totalCount	integer($int32)	Returns the total number of channels that are in that page
items	array[Object]	Returns the list of channel objects with detailed information for each channel.
publicId	string	Returns the public identifier for the channel
title	string	Returns the title of the channel
logo	string	Returns the URL for the channel's logo
healthStatus	string	Indicate the health status of the channel
liveStatus	string	Indicate the live status of the channel
inputType	string	Returns type of input used to create the channel
orderNumber	integer($int32)	Specified the order position of the channel
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed